Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added key words and phrases to docs index #6638

Merged
merged 1 commit into from
Oct 14, 2021

Conversation

ricklarsen
Copy link

@ricklarsen ricklarsen commented Oct 5, 2021

FORWARD PORT of #6625

What does this PR do?

populates the asciidoctor index within the documentation module.

Who is reviewing it?

@shaundmorris
@rececoffin
@sgalla
@jaymcnallie

Select relevant component teams:

@codice/docs

How should this be tested?

builds successfully; has index with links at the very of the pdf documents
every document in the target/docs/pdf directory should have its own index with just the topics in that guide. documentation.pdf should have all topics in its index.

Any background context you want to provide?

it's a lot of very small changes. two sets of parens displays the text as the anchor; three parens creates the anchor but hides the text. (I used that when there wasn't a properly capitalized use of a term, or when I wanted an extra anchor for an acronym.

Screenshots

Screen Shot 2021-09-20 at 2 30 50 PM

Checklist:

  • Documentation Updated
  • Update / Add Threat Dragon models
  • Update / Add Unit Tests
  • Update / Add Integration Tests

Notes on Review Process

Please see Notes on Review Process for further guidance on requirements for merging and abbreviated reviews.

Review Comment Legend:

  • ✏️ (Pencil) This comment is a nitpick or style suggestion, no action required for approval. This comment should provide a suggestion either as an in line code snippet or a gist.
  • ❓ (Question Mark) This comment is to gain a clearer understanding of design or code choices, clarification is required but action may not be necessary for approval.
  • ❗ (Exclamation Mark) This comment is critical and requires clarification or action before approval.

@ricklarsen
Copy link
Author

build now

@cxddfbot
Copy link

Internal build has been started, your results will be available at build completion.

@cxddfbot
Copy link

Build FAILURE See the job results in legacy Jenkins UI or in Blue Ocean UI.

@cxddfbot
Copy link

Internal build has been started, your results will be available at build completion.

@cxddfbot
Copy link

Build SUCCESS See the job results in legacy Jenkins UI or in Blue Ocean UI.

@ricklarsen ricklarsen merged commit bffddcf into codice:master Oct 14, 2021
@ricklarsen ricklarsen deleted the index-docs-master branch October 14, 2021 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants